<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: Bloomberg::quantum::IThreadFutureBase Struct Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d2/d27/structBloomberg_1_1quantum_1_1IThreadFutureBase-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Bloomberg::quantum::IThreadFutureBase Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="../../d9/db5/quantum__ithread__future__base_8h_source.html">quantum_ithread_future_base.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Bloomberg::quantum::IThreadFutureBase:</div>
<div class="dyncontent">
 <div class="center">
  <img src="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.png" usemap="#Bloomberg::quantum::IThreadFutureBase_map" alt=""/>
  <map id="Bloomberg::quantum::IThreadFutureBase_map" name="Bloomberg::quantum::IThreadFutureBase_map">
<area href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html" alt="Bloomberg::quantum::IThreadFuture&lt; T &gt;" shape="rect" coords="0,56,241,80"/>
<area href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html" title="Class representing a promised future. Can only be instantiated via a Promise object." alt="Bloomberg::quantum::Future&lt; T &gt;" shape="rect" coords="0,112,241,136"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a7a5e5adf9e104bef3f570aace79ecf5c"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#a7a5e5adf9e104bef3f570aace79ecf5c">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html">IThreadFutureBase</a> &gt;</td></tr>
<tr class="separator:a7a5e5adf9e104bef3f570aace79ecf5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a934b37ec3fc8f57406fbca24cc90c40a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#a934b37ec3fc8f57406fbca24cc90c40a">~IThreadFutureBase</a> ()=default</td></tr>
<tr class="memdesc:a934b37ec3fc8f57406fbca24cc90c40a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="#a934b37ec3fc8f57406fbca24cc90c40a">More...</a><br /></td></tr>
<tr class="separator:a934b37ec3fc8f57406fbca24cc90c40a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1bd3bb73b6afc51a757bdf258630a49"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#aa1bd3bb73b6afc51a757bdf258630a49">valid</a> () const =0</td></tr>
<tr class="memdesc:aa1bd3bb73b6afc51a757bdf258630a49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if this future still has a shared state with the promise object.  <a href="#aa1bd3bb73b6afc51a757bdf258630a49">More...</a><br /></td></tr>
<tr class="separator:aa1bd3bb73b6afc51a757bdf258630a49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9a1edaea33d7ef79e25b89b8c0c056d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#ad9a1edaea33d7ef79e25b89b8c0c056d">wait</a> () const =0</td></tr>
<tr class="memdesc:ad9a1edaea33d7ef79e25b89b8c0c056d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future value.  <a href="#ad9a1edaea33d7ef79e25b89b8c0c056d">More...</a><br /></td></tr>
<tr class="separator:ad9a1edaea33d7ef79e25b89b8c0c056d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f0909db9b8a21fb7146cb0cbf4b2af0"><td class="memItemLeft" align="right" valign="top">virtual std::future_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#a7f0909db9b8a21fb7146cb0cbf4b2af0">waitFor</a> (std::chrono::milliseconds timeMs) const =0</td></tr>
<tr class="memdesc:a7f0909db9b8a21fb7146cb0cbf4b2af0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future value up to a maximum 'timeMs' milliseconds.  <a href="#a7f0909db9b8a21fb7146cb0cbf4b2af0">More...</a><br /></td></tr>
<tr class="separator:a7f0909db9b8a21fb7146cb0cbf4b2af0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a7a5e5adf9e104bef3f570aace79ecf5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a5e5adf9e104bef3f570aace79ecf5c">&#9670;&nbsp;</a></span>Ptr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#a7a5e5adf9e104bef3f570aace79ecf5c">Bloomberg::quantum::IThreadFutureBase::Ptr</a> =  std::shared_ptr&lt;<a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html">IThreadFutureBase</a>&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a934b37ec3fc8f57406fbca24cc90c40a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a934b37ec3fc8f57406fbca24cc90c40a">&#9670;&nbsp;</a></span>~IThreadFutureBase()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual Bloomberg::quantum::IThreadFutureBase::~IThreadFutureBase </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Virtual destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa1bd3bb73b6afc51a757bdf258630a49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1bd3bb73b6afc51a757bdf258630a49">&#9670;&nbsp;</a></span>valid()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Bloomberg::quantum::IThreadFutureBase::valid </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determines if this future still has a shared state with the promise object. </p>
<dl class="section return"><dt>Returns</dt><dd>True if valid, false otherwise. </dd></dl>

<p>Implemented in <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a2160d4fb8675845b45923cacfc65e016">Bloomberg::quantum::Future&lt; T &gt;</a>.</p>

</div>
</div>
<a id="ad9a1edaea33d7ef79e25b89b8c0c056d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9a1edaea33d7ef79e25b89b8c0c056d">&#9670;&nbsp;</a></span>wait()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Bloomberg::quantum::IThreadFutureBase::wait </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future value. </p>
<dl class="section note"><dt>Note</dt><dd>This method blocks until the future is ready or until an exception is thrown. </dd></dl>

<p>Implemented in <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a2bb3a83f94187b49c6f142379b0ce0d7">Bloomberg::quantum::Future&lt; T &gt;</a>.</p>

</div>
</div>
<a id="a7f0909db9b8a21fb7146cb0cbf4b2af0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f0909db9b8a21fb7146cb0cbf4b2af0">&#9670;&nbsp;</a></span>waitFor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::future_status Bloomberg::quantum::IThreadFutureBase::waitFor </td>
          <td>(</td>
          <td class="paramtype">std::chrono::milliseconds&#160;</td>
          <td class="paramname"><em>timeMs</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future value up to a maximum 'timeMs' milliseconds. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">timeMs</td><td>The maximum amount of milliseconds to wait until the future value becomes ready. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>'ready' if value was posted before duration expired or 'timeout' otherwise. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until the value is ready, until 'timeMs' duration expires or until an exception is thrown. </dd></dl>

<p>Implemented in <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a6e602a8b6fa2df3fbac6b807bb1351fb">Bloomberg::quantum::Future&lt; T &gt;</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></li><li class="navelem"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html">quantum</a></li><li class="navelem"><a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html">IThreadFutureBase</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
